VIVE 3DSP Native C Library  ver 1.0.0.0
Audio 3DSP (3D Sound Perception) Native C Library
room.h
Go to the documentation of this file.
1 //========= Copyright 2016-2018, HTC Corporation. All rights reserved. ===========
2 #pragma once
3 #include "audio_engine.h"
4 
5 #ifdef __cplusplus
6 extern "C" {
7 #endif
8 
9  namespace HTC_Vive3DSP_SDK {
10  /*****************************************************************************************************************/
11  /* Room properties */
12  /*****************************************************************************************************************/
13 
19  typedef struct vive_3dsp_internal_room_ vive_3dsp_room;
20 
25  {
26  BG_None = 0,
37  };
38 
49  float reflection_rate[6];
50  float gain;
51  float dry_level;
53  float reverb_level;
54  //VIVE_3DSP_REVERB_MODEL reverb_model; /**< The physical occlusion engine. Please refer to \c ::VIVE_3DSP_OCCLUSION_ENGINE. */
55  };
56 
66  vive_3dsp_room_create_object(vive_3dsp_context *api);
77  vive_3dsp_room_destroy_object(vive_3dsp_context *api, vive_3dsp_room *room);
89  vive_3dsp_room_set_size(vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_Vector3 size);
101  vive_3dsp_room_set_position(vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_Vector3 pos);
113  vive_3dsp_room_set_rotation(vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_Quaternion rot);
128  vive_3dsp_room_set_material(vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_PLANE room_plane, VIVE_3DSP_REVERB_MATERIAL room_material);
141  vive_3dsp_room_set_reverb_preset(vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_REVERB_PRESET room_reverb_preset);
156  vive_3dsp_room_set_reflection(vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_PLANE room_plane, float rate);
168  vive_3dsp_room_set_gain(vive_3dsp_context *api, vive_3dsp_room *room, float gain);
180  vive_3dsp_room_enable(vive_3dsp_context *api, vive_3dsp_room *room, bool enable);
192  vive_3dsp_room_setDryLevel(vive_3dsp_context *api, vive_3dsp_room *room, float level_dB);
204  vive_3dsp_room_setReflectionLevel(vive_3dsp_context *api, vive_3dsp_room *room, float level_dB);
216  vive_3dsp_room_setReverbLevel(vive_3dsp_context *api, vive_3dsp_room *room, float level_dB);
228  vive_3dsp_room_set_property(vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_PROPERTY prop);
239  vive_3dsp_room_get_bgaudio(vive_3dsp_context *api, int id);
250  vive_3dsp_room_free_bgaudio(vive_3dsp_context *api, float *pBgaudio);
251  }
252 #ifdef __cplusplus
253 }
254 #endif
Definition: audio_engine.h:158
Definition: audio_engine.h:144
VIVE_3DSP_ROOM_REVERB_PRESET preset
Definition: room.h:47
VIVE_3DSP_ROOM_PLANE
Definition: audio_engine.h:77
VIVE_3DSP_API_STATUS
Definition: audio_engine.h:25
#define VIVE_3DSP_API_DLLEXPORT
Definition: audio_engine.h:6
float reflection_level
Definition: room.h:52
VIVE_3DSP_REVERB_MATERIAL material[6]
Definition: room.h:48
Definition: room.h:36
Definition: room.h:26
Definition: room.h:32
Definition: room.h:33
VIVE_3DSP_ROOM_REVERB_PRESET
Definition: audio_engine.h:68
float reverb_level
Definition: room.h:53
Definition: room.h:34
Definition: room.h:28
float reflection_rate[6]
Definition: room.h:49
VIVE_3DSP_Vector3 position
Definition: room.h:44
The vive_3dsp_context structure represents the overall audio engine of 3D sound model.
Definition: vive_3dsp_api.h:15
float dry_level
Definition: room.h:51
VIVE_3DSP_REVERB_MATERIAL
Definition: audio_engine.h:51
The vive_3dsp_room structure represents the 3D room model, including the reflection and reverberation...
RoomBackgroundAudioType
Definition: room.h:24
Definition: room.h:31
Definition: room.h:27
VIVE_3DSP_Quaternion rotation
Definition: room.h:45
VIVE_3DSP_Vector3 size
Definition: room.h:46